widgets.brease.PDFViewer

Widget Description

short: PDF Dokument anzeigen
de: Zeigt ein PDF Dokument und erlaubt dem Benutzer eine Bedienung des Dokuments
en: Displays a PDF document and allows an user interaction with the document

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
documentZoom Zoom and scroll factors for the displayed document, in the following format: zoom-value, left-offset, top-offset. Note that scroll factors are optional. Viewer-specific options apply - please consult help for further details. Behavior String auto false false false false false true pdfOpenParameters 2
enable Initial option to enable widget. Behavior Boolean true true false false false false true
namedDest Loads the document at the specified named destination. Behavior String false false false false false true pdfOpenParameters 3
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
showToolbar Enable the display of the PDF viewer toolbar (limited compatibility). Behavior Boolean false false false false false false true pdfOpenParameters 4
src Path to the pdf file; a text key may be used. Data PdfPath true false false true false true
startPage Loads the document on the configured page number. Behavior UNumber 0 false false false false false true pdfOpenParameters 1
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer -1 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
usePlugin If TRUE (default), a javascript plug-in will be used to display the PDF. If FALSE, the browser's embedded PDF viewer will be used to display the document. Note: the embedded viewer will typically offer faster performance, but not available on all client platforms. Behavior Boolean true false false false false false true
visible change visibility Behavior Boolean true true false false false false true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 320 false false false true true
width outer width of widget Size 240 false false false true true

Styleable Properties

name type description defaultValue
borderWidth PixelValCollection

Sets the width of the border.

 0px
borderColor ColorCollection

Sets the border color

 #FFF
borderStyle BorderStyle

Style of the Border of the widget

 solid
cornerRadius PixelValCollection

Sets the radius of the widget rounded corners.

 0px
padding Padding

Padding of the Widget

 0 10px
margin Margin

Margin of the Widget

 0px
opacity Opacity

Opacity of the widget

 1
rotation Rotation

Rotation of widget.

 0deg

Events

name description arguments
EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
ClearSrc Clears source location of PDF document, and removes it from viewer.
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
GoToPage Navigates to a certain page
  • value: UInteger

    Navigate to this page.

SetEnable Sets the state of property «enable»
  • value: Boolean

SetSrc Sets source location of PDF document.
  • value: String

    Path of the PDF document, e.g. "/Media/HelpPDF.pdf"

SetStyle
  • value: StyleReference

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip